Skip to main content
Feedback

Upgrading from 6.0.0 to 6.1.0 (introduced in v6.1.0)

Steps to upgrade

note

Before you begin, ensure the Boomi Cloud API Management - Local Edition 6.0.0 cluster is up and running.

Procedure

  1. Build new images.

    Refer to Building Images for more information.

  2. Patch the existing service account, role, and rolebinding to be managed by Helm.

    1. Patch rolebinding

      kubectl annotate rolebinding apiml-role-binding meta.helm.sh/release-name=<release name used to deploy the application>
      Ex. kubectl annotate rolebinding apiml-role-binding meta.helm.sh/release-name=apiml600

      kubectl annotate role-binding apiml-role-binding meta.helm.sh/release-namespace=<namespace in which the application is deployed>
      Ex. kubectl annotate role-binding apiml-role-binding 
      meta.helm.sh/release-namespace=default

      kubectl label rolebinding apiml-role-binding app.kubernetes.io/managed-by=Helm

    2. Patch roles

      kubectl annotate role apiml-role 
      meta.helm.sh/release-name=<release name used to deploy the application>
      Ex. kubectl annotate role apiml-role 
      meta.helm.sh/release-name=apiml600

      kubectl annotate role apiml-role meta.helm.sh/release-namespace=<namespace in which the application is deployed>
      Ex. kubectl annotate role apiml-role meta.helm.sh/release-namespace=default

      kubectl label role apiml-role app.kubernetes.io/managed-by=Helm

    3. Patch service account

      kubectl annotate sa <name of sa> 
      meta.helm.sh/release-name=<release name used to deploy the application>
      Ex. kubectl annotate sa apiml-sa meta.helm.sh/release-name=apim

      kubectl annotate sa <name of sa> 
      meta.helm.sh/release-namespace=<namespace in which the application is deployed>
      Ex. kubectl annotate sa apiml-sa meta.helm.sh/release-namespace=default

      kubectl label sa <name of sa> app.kubernetes.io/managed-by=Helm
      Ex. kubectl label sa apiml-sa app.kubernetes.io/managed-by=Helm

  3. Update override files to upgrade cluster and move values to the global section. We recommend using the overrides file.

    The following table lists the values moved to the global location along with their previous and new locations.

    ValuePrevious locationNew locationNew name
    Area UUIDConfigui sub chart mlc_oauth_scopegloballocalDevOAuthScope
    Local dev admin userConfig UI Sub chart adminUsergloballocalDevAdminUser
    cacheloader valuescacheloader subchart-loader values
    cacheloadercron valuescacheloadercron subchart-loadercron values

  4. Upgrade the database schema for member_role_audit_log table from apim/apim-le-toolkit.

    important

    This table needs an update for successful migration from Boomi Cloud API Management - Local Edition (formerly known as Mashery Local) 4.x, 5.x, and future upgrades.

    [ec2-user@ip-10-0-0-174 ~]$ docker ps
    CONTAINER ID   IMAGE                         COMMAND       CREATED      STATUS      PORTS     NAMES
    dca78a3d66e3   apim/apim-le-toolkit:v6.1.0   "/bin/bash"   6 days ago   Up 6 days             eloquent_davinci
    [ec2-user@ip-10-0-0-174 ~]$ docker exec -it dca78a3d66e3 bash
    I have no name!@dca78a3d66e3:/$ cd /opt/apim/db
    I have no name!@dca78a3d66e3:/opt/apim/db$ ls -lart
    total 156
    -rw-rw-r--. 1 root  root    133 Oct 24 19:08 upgrade-schema-6.0.0_6.1.0.sql
    -rw-rw-r--. 1 root  root    133 Oct 24 19:08 rollback-schema-6.1.0_6.0.0.sql
    -rw-rw-r--. 1 root  root   1646 Oct 24 19:08 apim-le-db-token-purger-schema_6.0.0.sql
    -rw-rw-r--. 1 root  root 136174 Oct 24 19:08 apim-le-db-schema_6.1.0.sql
    -rw-rw-r--. 1 root  root   1227 Oct 24 19:08 apim-le-db-counter-purger-schema_6.1.0.sql
    -rw-rw-r--. 1 root  root   1239 Oct 24 19:08 apim-le-db-audit-purger-schema_6.1.0.sql
    drwxr-xr-x. 1 root  root     16 Nov 12 04:28 ..
    drwxr-xr-x. 1 65532 root     45 Nov 12 04:28 .
    I have no name!@dca78a3d66e3:/opt/apim/db$ MYSQL_PWD=<Password> mysql -h <Host-ip>  -umasheryonprem --database=name masherysolar < upgrade-schema-6.0.0_6.1.0.sql

    -------------------------
    Check in the mysql instance

    MySQL [masherysolar]> desc member_role_audit_log;
    +---------------+--------------+------+-----+---------+----------------+
    | Field         | Type         | Null | Key | Default | Extra          |
    +---------------+--------------+------+-----+---------+----------------+
    | handle        | varchar(255) | NO   |     | NULL    |                |
    | role_id       | int unsigned | NO   |     | NULL    |                |
    | area_id       | int unsigned | NO   | MUL | NULL    |                |
    | changed_by    | varchar(255) | NO   |     | NULL    |                |
    | changed_on    | datetime     | YES  |     | NULL    |                |
    | change_type   | char(1)      | YES  |     | NULL    |                |
    | delta         | longtext     | YES  |     | NULL    |                |
    | auto_id       | int          | NO   | PRI | NULL    | auto_increment |
    | is_anonymized | tinyint(1)   | YES  |     | 0       |                |
    | id            | int          | YES  |     | NULL    |                |
    +---------------+--------------+------+-----+---------+----------------+
    10 rows in set (0.032 sec)

    MySQL [masherysolar]> select  * from member_role_audit_log;
    +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
    | handle         | role_id | area_id | changed_by | changed_on          | change_type | delta                                                    | auto_id | is_anonymized | id   |
    +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
    | AutoBOTUser333 | 4000003 |    2222 | admin      | 2024-10-23 16:47:21 | U           | {"role_id":{"+":"567dbc68-d9d1-48b9-b039-52d6f10477f2"}} |       1 |             0 | NULL |
    +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
    1 row in set (0.026 sec)

  5. Upgrade using Helm. To upgrade the cluster using Helm, run the following command:

    [ec2-user@ip-10-0-0-174 deploy]$ helm upgrade apim .
    Release "apim" has been upgraded. Happy Helming!
    NAME: apim
    LAST DEPLOYED: Tue Nov 12 08:19:37 2024
    NAMESPACE: ajinkya
    STATUS: deployed
    REVISION: 2
    TEST SUITE: None
    -----------------------------

    [ec2-user@ip-10-0-0-174 ~]$ helm history apim
    REVISION    UPDATED                     STATUS      CHART       APP VERSION DESCRIPTION
    1           Tue Nov 12 07:25:51 2024    superseded  apim-6.0.0  1.0         Install complete
    2           Tue Nov 12 08:19:37 2024    deployed    apim-6.1.0  1.1.0       Upgrade complete

tip

If you are facing any issues when upgrading to Boomi Cloud API Management – Local Edition 6.1.0, consider rolling back to the previous 6.0.0 version.

Refer to Rollback from 6.1.0 and 6.2.0 to Previous 6.x Versions for more information.

On this Page